home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 176-200 / scopedisk194 / screenx-v3.0 / screenx.docs < prev    next >
Text File  |  1995-03-19  |  13KB  |  307 lines

  1.  
  2.                    ScreenX 3.0 Documentation
  3.                              by Steve Tibbett
  4.  
  5.  
  6.  
  7. INTRODUCTION
  8.  
  9. ScreenX was originally designed to make getting at screens easier -
  10. especially screens that are lost behind other screens that don't give you
  11. depth gadgets.  Chessmaster was the original culprit.
  12.  
  13. To make getting at ScreenX easier, I gave it a window on the Workbench
  14. screen, and since it was always going to be there anyway, I wrote into that
  15. window the amount of available memory and the time.
  16.  
  17. You can't work with Screens while ScreenX is in that tiny window on the
  18. Workbench screen, though - you've got to get ScreenX active first.  (We'll
  19. talk about doing that later - if you've run ScreenX already, click in the
  20. ScreenX window and tap the space bar).  Once ScreenX is active, you'll have
  21. a big black screen with a list of screens down the left edge, and a bunch
  22. of huge gadgets down the right.
  23.  
  24. From here you can pick any screen that's open and work with it.  Working
  25. with it means Popping it to the front, Pushing it to the back, saving it to
  26. an IFF file, printing it, or even trying to close it!  (Though this has
  27. some rather nasty implications, which we'll talk about later).
  28.  
  29. ScreenX is fully compatible with the 2.0 Amiga system software, and even
  30. takes advantage of it where possible, without affecting how it runs
  31. under 1.3.  There is one new feature available to 2.0 users, however,
  32. that being the Pop-Up menu available anywhere while ScreenX is running.
  33. (there's a section on that later)
  34.  
  35.  
  36. INSTALLATION
  37.  
  38. For ScreenX to be really useful, it needs to be available.  Loading
  39. it automatically when you reset your computer is the best way to do this,
  40. and it's relatively easy to do.  
  41.  
  42. If you're using 1.3, you need to get "Run >NIL: <NIL: ScreenX" into your
  43. Startup-Sequence, probably near the end, but before the "EndCLI" (if you
  44. have one).  Assuming you are using a standard Commodore Workbench setup,
  45. you have a Text Editor handy - "Ed".  Open up a CLI window, and type 
  46. "ED S:Startup-Sequence"... Ed will load, and show you the file.  Move down
  47. to the end of it, then back up a few lines with the cursor keys, and
  48. type "RUN >NIL: <NIL: ScreenX", hit return, then hit ESC, X, then return.
  49. That's it - next time you reset, you should end up with screenX on your
  50. Workbench screen.
  51.  
  52. There are some options that apply when ScreenX is started from the
  53. CLI (or from the Startup-Sequence), these are:  
  54.  
  55. "-e" tells ScreenX to be a little less agressive in updating it's memory
  56. display - ScreenX normally udpates it 5 times a second.  With this option,
  57. it will be updated once every 1.5 seconds...  meaning it will take a little
  58. less processor time, but will be less accurate.
  59.  
  60. "-x" and "-y" let you change the position the ScreenX window comes up in.
  61. For instance, saying "ScreenX -x15 -y100" would put ScreenX halfway down
  62. the screen, 15 pixels over from the left edge (the x axis).
  63.  
  64. "-t" uses a 12 hour clock instead of a 24 hour one.
  65.  
  66. "-f" uses full numbers instead of numbers of "K" to show memory, meaning
  67. that 16384 bytes free would be shown as 16384 instead of 16.
  68.  
  69. "-c" will disable changing colour 0 to White and colour 1 to Black for 
  70. printing purposes.  Without this option, when you tell it to print a
  71. screen, color 0 and color 1 become white and black, which makes the
  72. printout usually look better (depending on what you are printing).
  73. If you are printing digitized pictures, or anything else where the
  74. colours actually matter, then you should use this option.
  75.  
  76. If you're using the 2.0 operating system, simply drop the "ScreenX" icon
  77. into the WBStartup drawer.  That's it - ScreenX will get loaded when the
  78. Workbench is next loaded.
  79.  
  80.  
  81.  
  82. THE SMALL WINDOW
  83.  
  84. The small window ScreenX opens on the Workbench is just a clock and memory
  85. meter, but it gives you a way to talk to ScreenX.  
  86.  
  87. Clicking in the small window and typing "F" will change the display from 
  88. showing total free memory to showing the largest chunk of free memory for
  89. each of the two areas of memory (Chip RAM and Fast RAM).  
  90.  
  91. Not having a large enough chunk of free memory is just as bad as being out
  92. of memory - If you find you've got hundreds of K of memory free, but the
  93. largest piece is only a few K large, it's time to reboot.
  94.  
  95. Typing space with the small window active will bring up the Big window - 
  96. Pressing the right mouse button will do the same thing.  
  97.  
  98. Pressing "N" will do the same thing as finding a CLI window and typing
  99. "NEWCLI" into it - it will pop up a new CLI window.  Pressing "W" will
  100. do the same, but with "NewWSH" for WShell users.
  101.  
  102. Hitting ESCAPE or just clicking on the close box will make ScreenX
  103. quit - it will instantly close it's window and leave.
  104.  
  105.  
  106. THE BIG WINDOW
  107.  
  108. The main window has three different "Modes" it can be in.  There's
  109. "Screens" mode, where it's showing you a list of screens down the left
  110. side, "Programs" mode, where it's showing you a list of programs down
  111. the left side, and "Info" mode, where it's got screens on the left and
  112. a "Screen Info" window on the right.
  113.  
  114. "Screens Mode"
  115.  
  116. Screens mode where all screen manipulations are done.  In this mode, the
  117. gadgets down the right side are all applicable, and on the currently
  118. selected screen, perform the following functions:
  119.  
  120. Pop Screen To Front:  This gadget will take the currently selected
  121.         screen and pop it to the front.  Handy for getting 'Hidden' screens 
  122.     back.
  123.  
  124. Push Screen To Back:  If you have 4 screens in memory, and one of 
  125.     them doesn't have Depth gadgets, you can push that one to the back, 
  126.     and as long as you don't click any of the other screens back 
  127.     behind it, you won't have any problems.  (If you do click anything 
  128.     else behind it, you'll have to use ScreenX to get them back!)
  129.  
  130. Update Screen List:  This will redraw the list of screens that is 
  131.     being shown.  Necessary if any of the listed screens close down 
  132.     while you are looking at them, or if new screens appear.  Note that 
  133.     any action taken on a screen that is no longer around is 
  134.     ignored (even clicking on it).
  135.  
  136. Cycle All Screens:  I'll let you figure this one out on your own.  
  137.     Note that to make it stop, you must click anywhere in the
  138.     main ScreenX screen...  (if you can catch it!)
  139.  
  140. Close Screen:  Danger.  You got it.  This isn't something you 
  141.     should be doing unless you KNOW what you are doing.  It will let 
  142.     you CLOSE DOWN the screen of your choice.  The problem with this is 
  143.     that if anybody else decides to write on that screen at any time, 
  144.     our machine will probably crash.  What it's really useful for is 
  145.     when a program crashes, you can close it's screen to free up
  146.     the Chip RAM the screen is using.  Just make sure you don't 
  147.     go closing the Workbench down, OK?
  148.  
  149. Save Screen to IFF File:  This gadget will instantly turn the 
  150.     screen Red (so you know something's going on), and save the screen 
  151.     selected into the filename in the Text gadget at the bottom of the 
  152.     screen.  Note that the filename in that gadget must include the 
  153.     full pathname, or else if you just type a filename in there, it will 
  154.     be written to the current directory.
  155.  
  156. Print Screen:  Clicking once on this gadget will start printing the screen
  157.     selected to the printer you've selected in preferences, using the
  158.     options that you set there.  Clicking again will stop the printout.
  159.  
  160.  
  161. Screen Info:  Shows you information about the selected screen, like 
  162.     the current font that screen is using, the amount of 
  163.     memory that screen is using (Note:  If it says 32K, it
  164.     really means 32000 bytes), the number of Windows open on 
  165.     that screen, and the number of Gadgets on that screen.  The 
  166.     depth of that screen too - Depth = Number Bitplanes.  
  167.     (It's always fun to run a bunch of programs, and then
  168.     try to find all the gadgets...)
  169.  
  170. A warning here about printing screens:  Just after I added the
  171. Print Screen gadget, while I was testing it, I ran into a weird
  172. problem - I could print, say, the DiskX screen, but if I tried to
  173. print the ScreenX screen, or the Workbench screen, I'd get a blank
  174. page.  It turns out that if your preferences are set for
  175. Black and White, and your screen colors are not far enough apart
  176. to be Black and White, it will print all white - White's an easy color
  177. to print...  ScreenX now assumes that colour 0 is the Background colour.
  178. This is not what you want if you are trying to get an accurate
  179. representation of the screen, which is why the "-c" command line option
  180. was provided (see INSTALLATION).
  181.  
  182.  
  183. HOTKEYS
  184.  
  185. Hotkeys are valid in any ScreenX window.  There are two Hotkeys - 
  186. "Left-Amiga-Help" will summon the ScreenX full screen, wherever you
  187. are.  This lets you find any screen in the system reasonably quickly
  188. without ever reaching for your mouse - This works because when you hit
  189. Left-Amiga-Help, the screen list pops up.  You can then hit the down
  190. arrow, until the screen you want is hilited, then hit Return - the ScreenX
  191. screen will disappear and the selected screen will pop to the front, and
  192. the first window on that screen will be activated.
  193.  
  194. "Left-Amiga-Del" will save the frontmost screen.  This can be especially
  195. useful for grabbing screens with menus - you can pull down a menu, 
  196. then hit Left-Amiga-Del while holding down the right mouse button, and
  197. capture an image of the menu.  (Good luck doing that with just two hands!)
  198.  
  199.  
  200. SAVED SCREENS
  201.  
  202. When you save a screen in ScreenX, the screen will be saved to the
  203. last filename you entered into the filename gadget on the main
  204. ScreenX screen.  Any existing file will be overwritten, UNLESS
  205. the filename ends with ".<number>".  If it ends with ".1" (ie, 
  206. "Picture.1"), ScreenX will try to save it as "Picture.1".  If
  207. "Picture.1" exists, it will try "Picture.2", and so on, until it finds
  208. one.  This is good for, say, touring all the Intuition Menus in a
  209. program you are writing a manual (or review) for, as you can show the
  210. menu, hit the Save key, wait for the Screen to flash (it flashes when
  211. it's done saving), then move the mouse to the next menu and hit the
  212. key again.
  213.  
  214. Note that ScreenX will not do anything unusual if a disk error 
  215. occurs during the save - the file will be truncated but no error
  216. will be displayed.  You should make sure you have enough room before
  217. starting.
  218.  
  219.  
  220. PROGRAM MODE
  221.  
  222. A new item to 3.0: ScreenX can now present you with a list
  223. of programs, and let you run one of them.  For this to work, you
  224. must create a file named 'S:ScreenX.Config', which will contain lines
  225. of the form
  226.  
  227. LineToBeDisplayed
  228. CommandToBeExecuted
  229. LineToBeDisplayed
  230. CommandToBeExecuted
  231. LineToBeDisplayed
  232. CommandToBeExecuted
  233. ...and so on.
  234.  
  235. The LineToBeDisplayed will be shown on the ScreenX screen for you to
  236. select, and the CommandToBeExecuted will be executed if you 
  237. hit return with it selected, or click 'Pop To Front' with it
  238. selected.
  239.  
  240. When you bring up the ScreenX screen (via Left-Amiga-Help if you haven't
  241. changed it from the default), you can hit Tab to switch between the
  242. list of screens and the list of programs, then hit the arrow keys to
  243. select the one you want, and return.  If you decide you don't want one,
  244. just hit escape.
  245.  
  246. The mode you last used (Program or Screen) will be remembered for the next
  247. time you summon the big window.
  248.  
  249.  
  250. SCREENX AND 2.0
  251.  
  252. There is one new feature that ScreenX has under 2.0, perhaps it's nicest
  253. feature.  On any screen, holding down the Left-Amiga key and tapping the
  254. Right Mouse Button will bring up a window with a list of all the screens
  255. in it under the cursor - just move the mouse to the screen you want, and let
  256. go - that screen will be popped to the front, and the first window on it
  257. activated.
  258.  
  259.  
  260. MIDDLE MOUSE BUTTON
  261.  
  262. If you have a middle mouse button, hitting it under 2.0 will do the same 
  263. as hitting the Left-Amiga-Help keystroke, ie, call up the big window.
  264.  
  265.  
  266.  
  267.  
  268. AUTHOR AND DISTRIBUTION INFORMATION
  269.  
  270. ScreenX is freely redistributable, but is also Copyright 1990 Steve Tibbett.
  271. Source is not available.  Distribution is only very slightly limited:
  272. You may not distribute ScreenX without it's current documentation, and
  273. if it is to be commercially distributed, I won't demand but I would
  274. appreciate being sent a copy of whatever it is being distributed with
  275. or on (in the case of disk magazines).
  276.  
  277. Like all my stuff, ScreenX will likely continue to change.  If you like
  278. ScreenX, check with wherever you got it every few months for updated
  279. versions, especially if you have problems with it (and have let me
  280. know about them), as I normally fix problems quickly.
  281.  
  282. I don't ask for any cash contribution for ScreenX.  If you are feeling
  283. guilty and just want to send something, send an original game or
  284. a neat demo, I'll probably appreciate it more than cash.
  285.  
  286.  
  287. My Virutal Addresses:
  288.  
  289.     My BBS is 613-731-3419, up 24 hours/day running my own BBS (BBX)...
  290.     You can reach me on Plink (where I'm an Asst. Chair) as STEVEX...
  291.     You can reach me on Bix as "s.tibbett"...
  292.     You can reach me through FidoNet on point 1:163/109.42...
  293.     You can send me Usenet mail at cognos!alzabo!omx!stevex...
  294.     Or you can call me at 613-731-5316.
  295.  
  296.     I prefer talking with people electronically (including phone) rather
  297.     than mail - I answer all email, but very little paper mail.
  298.  
  299.  
  300. My Physical Address:
  301.  
  302.            Steve Tibbett
  303.            2710 Saratoga Pl. #1108
  304.            Gloucester, Ontario
  305.            K1T 1Z2
  306.  
  307.